Maintaines a list of LSAPhoneItems
- Version:
-
1.2.5, 23.NOV.2000
- History:
| 23.NOV.2000 | RGR | Bug in Get PhoneNumberDefaults
|
| 11.AUG.2000 | RGR | Bug in Set PhoneFormat and Set CountriesWithoutAreaCode
|
| 26.JUL.2000 | RGR | Refreshing list (formatted values) if handle to parent changes
|
| 25.JUL.2000 | RGR | PhoneFormat for all numbers maintained in list
|
| 25.JUL.2000 | RGR | Functionality for countries without area code
|
| 25.JUL.2000 | RGR | Constant names changes
|
| 08.JUN.2000 | RGR | Delete method changed
|
Public Property Set AddrDataID AsString
Sets the Instance ID of the LSAAddressData object. If this ID isn't available then
the properties PhoneFormat and CountriesWithoutAreaCode have to use their
default values. The ID is set by the object LSAAddressData when this object is accessed
via the Property "PhoneNumbers" of the class LSAAddressData.
Public Property Get AddrDataID AsString
Public Property Get AddrDataInstance AsVariant
If the property AddressDataID is set to an correct Instance ID of the
LSAAddressData object which can be obtained by the instance manager
class this property returns a handle to object.
- History:
| 10.AUG.2000 | RGR | ID = "" didn't work correctly
|
Public Property Get PhoneFormat AsVariant
Public Property Set PhoneFormat AsVariant
- History:
| 11.AUG.2000 | RGR | Missing exit property
|
Public Property Get CountriesWithoutAreaCode AsVariant
Public Property Set CountriesWithoutAreaCode AsVariant
- History:
| 11.AUG.2000 | RGR | Missing exit property
|
Public Property Get DefaultPhoneNumber AsString
Returns the formatted attribute of the default phone item of the named list. If
the list is empty an empty string is returned.
- History:
| 27.JUL.2000 | RGR | If no default item exists an empty string is returned.
|
Public Property Get PhoneNumberList AsVariant
Returns an array of serial data strings. Each entry corresponds to a
phone number in the NamedList and can be used to explode the list.
Public Property Get PhoneNumberKeyS AsVariant
Returns an array of string with the keys
of the phone numbers maintained in the web page list
Public Property Get PhoneNumberS AsVariant
Returns an array of string filled with the
the formatted attribute of the PhoneNumberItems
maintained in the web page list
Public Property Get PhoneNumberDefaultS AsVariant
Returns an array of strings. On the position of the DefaultItem of
the list the value is "x"
- History:
| 23.NOV.2000 | RGR | CurrentItemKey Pointer not moved correctly
|
Public Property Get Count AsInteger
Returns the number of elements in the web page list
Public Property Set ListDelimiter AsString
When the object is imploded to a serial data string this character will be used as seperator.
If the programmer doesn't set a delimiter a default value will be delivered by the class.
Public Property Get ListDelimiter AsString
Public Property Set ItemDelimiter AsString
When the an item is imploded to a serial data string this character will be used as seperator.
If the programmer doesn't set a delimiter a default value will be delivered by the class.
Public Property Get ItemDelimiter AsString
Public Property Set NotAllowedChars AsVariant
These characters are not allowed to be use in the items
Public Property Get NotAllowedChars AsVariant
New
Public Sub New
Initialzes the internal NamedLists.
Delete
Public Sub Delete
Default destructor of the class. Deletes all child objects.
- History:
| 25.JUL.2000 | RGR | Delete handle to parent
|
| 08.JUN.2000 | RGR | Child objects are deleted.
|
AddItem
Public Sub AddItem(NewItem As LSAPhoneItem)
Adds a new LSAPhoneItem to the list
- Parameters:
| newItem | LSAPhoneItem | the item which is inserted in the list
|
ClearCurrentItem
Public Sub ClearCurrentItem
Deletes the current item from the list
ClearAllItems
Public Sub ClearAllItems
Reinitializes the phone list
UpdateCurrentItem
Public Sub UpdateCurrentItem(UpdateItem As LSAPhoneItem)
Updates the current item with the data from the UpdateItem
- Parameters:
| updateItem | LSAPhoneItem | item storing the update information
|
IsDefault
Public Function IsDefault(CompareItem As LSAPhoneItem) As Integer
Checks if the parameter item is the default item of the list.
- Parameters:
| CompareItem | LSAPhoneItem | the item which is checked if it is the default item
|
- Returns:
| Boolean | true, if the item is the default item
|
SetCurrentItem
Public Sub SetCurrentItem(NewCurrentItem As LSAPhoneItem)
Set the current item to the parameter item
SetDefaultItem
Public Sub SetDefaultItem(NewDefaultItem As LSAPhoneItem)
Set the default item to the parameter item
GetItemByKey
Public Function GetItemByKey(ItemKey As String,MoveCurrentItem As Integer) As LSAPhoneItem
GetDefaultItem
Public Function GetDefaultItem As LSAPhoneItem
Returns the default item of the list or nothing.
- Returns:
| LSAPhoneItem | the default item
|
GetCurrentItem
Public Function GetCurrentItem As LSAPhoneItem
Returns the current item of the list
- Returns:
| LSAPhoneItem | item which the current pointer is pointing at
|
GetFirstItem
Public Function GetFirstItem As LSAPhoneItem
Returns the first item of the list
- Returns:
| LSAPhoneItem | the first item in the list
|
GetNextItem
Public Function GetNextItem As LSAPhoneItem
Returns the item next to the current item of the list.
- Returns:
| LSAPhoneItem | next item to the current item
|
GetPreviousItem
Public Function GetPreviousItem As LSAPhoneItem
saveToPredefinedFields
Public Function saveToPredefinedFields(doc As NotesDocument) As Integer
Stores attribute values for the convinience of the programmer. The
fields of documents relate to the subform LSASubPhone from LSL-Address
The attribute are only stored if they differ from the values on disk.
- Parameters:
| doc | NotesDocument | the document in which the attributes are stored
|
- Returns:
| Boolean | true, if an document item has been changed
|
Explode
Public Sub Explode(SerialDataArr As Variant)
Fills the list with the serialized object provided by the parameter array
The array should be of th form
' [~~x~Office~49~123~12345~12~+49-(0)123-123 45-12,
' ~~~Mobile~49~172~12345~~+49-(0)172-123 45]
The list also reinitialized this means hasChanged delivers false.
- Parameters:
| SerialdataArr | Variant | array of serial data strings each entry representing an item
|
hasChanged
Public Function hasChanged As Integer
Checks if the list has been modified since creation or the last call of the explode
method.
getPhoneData
Public Function getPhoneData As String
Interface for the class LSAAddressData. Calculates a string of the
type ##LotusP# as used in the default data string
of an unit
| Top | LotusScript Doc |
| © Lotus Professional Services |
| generated on : 05-Apr-01 8:40:00 AM |